package de.metas.dunning.spi;

/*
 * #%L
 * de.metas.dunning
 * %%
 * Copyright (C) 2015 metas GmbH
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 2 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-2.0.html>.
 * #L%
 */


import java.util.Iterator;

import de.metas.dunning.api.IDunnableDoc;
import de.metas.dunning.api.IDunningContext;

/**
 * A Dunnable Source is an {@link Iterable} object which provides source documents.
 * 
 * e.g. We can have InvoiceSource which provides {@link IDunnableDoc}s for {@link org.compiere.model.I_C_Invoice}s that are dunnable.
 * 
 * @author tsa
 * 
 * @param <T>
 */
public interface IDunnableSource
{
	/**
	 * Returns an iterator over a set of source documents.
	 * 
	 * @return iterator
	 */
	Iterator<IDunnableDoc> iterator(IDunningContext context);

	String getSourceTableName();
}
